home *** CD-ROM | disk | FTP | other *** search
/ Almathera Ten Pack 3: CDPD 3 / Almathera Ten on Ten - Disc 3: CDPD3.iso / scope / 101-125 / scopedisk120 / cb / cb.doc < prev    next >
Text File  |  1995-03-19  |  10KB  |  217 lines
  1.  
  2.                         Console Buffer by
  3.                         William J. Fritz
  4.                         4504 E. Yates Rd.
  5.                         Bensalem, Pa. 19020
  6.                         215-245-1584
  7.  
  8.  
  9. CONDITIONS FOR USE AND DISTRIBUTION:
  10.  
  11.    CB is Copyright (c) 1990 by William J. Fritz
  12.  
  13.    CB is a copyrighted program that is provided "as is". There is no
  14. warranty, either expressed or implied, as to the quality or usefullness
  15. of the program. The user of the program accepts all risks associated with
  16. it's use.
  17.  
  18.    CB is freely distributable provided:
  19.  
  20.    1. The files are all left intact.
  21.    
  22.    2. No charge is made for CB (other than a reasonable copy charge of $6.00
  23.       or less)
  24.    
  25.    3. CB is not packaged as a part of a commercial product.
  26.  
  27.    4. CB may not be uploaded to any electronic service that claims
  28.       a copyright to it's files and programs.
  29.  
  30. DESCRIPTION:
  31.  
  32.    Console Buffer is for CLI users who would like to have a history
  33. and/or hardcopy (either file or device) of their console input and output.
  34. It works with both CLI and shell windows. Console I/O is saved in a
  35. buffer, the size of which is set by the user. The default buffer size is
  36. 100 lines.
  37.  
  38.    When the program is started a  proportional gadget is attached to the
  39. console window that can be used to scroll through the console I/O just as
  40. you would use a word processor vertical scroll gadget.
  41.  
  42.    The Console Buffer program consists of two modules.
  43.  
  44.    CB -              CB loads CB-handler if it is not loaded and
  45.                      interprets the command line arguments. If CB-handler
  46.                      is present the current status is reported.
  47.  
  48.    CB-handler -      CB-handler monitors the console that CB was started
  49.                      from, builds the buffer in memory and displays the
  50.                      buffer data. This module must be placed in either the
  51.                      current directory or the L: directory of the system
  52.                      disk in order for CB to find it.
  53.  
  54. CLI Argument Help:
  55.  
  56.    For command line argument help type <CB ?>.
  57.  
  58. START:
  59.  
  60.    To start CB type <CB> at the console you wish to monitor--this will
  61. use the default of 100 lines. Do not "run" the program. (e.g. "run CB"). If
  62. you wish another number of lines saved open with <CB -l###>, ### being the
  63. number of lines to save. For a hard-copy of the Console I/O start with
  64. <CB -hname>, the name being either a file name or device name. (e.g.<CB -hPRT:>
  65. to have the printer as the hardcopy device)
  66.    The -o, -q and -r options to output buffer, quit and reset cannot be used
  67. at Console Buffer startup as they pertain to a currently active buffer only.
  68.  
  69. DISPLAY:
  70.  
  71.    To display the buffer click on the proportional gadget in the right
  72. border of the console window. The title line of the console window will
  73. be changed to indicate display mode is active.
  74.  
  75.    While in display mode use either the prop gadget or the up and down
  76. arrow keys to view the buffer.
  77.  
  78.    up-arrow                scroll down one line
  79.    down-arrow              scroll up one line
  80.    shift-up-arrow          scroll down one window frame
  81.    shift-down-arrow        scroll up one window frame
  82.    control-up-arrow        scroll to top of buffer
  83.    control-down-arrow      scroll to bottom of buffer
  84.  
  85.    Single line scrolling is also possible by clicking and holding the mouse
  86. within the display window. The area that the mouse pointer occupies determines
  87. the speed and direction of scrolling. The window is divided into five horizontal
  88. zones of equal size. The center zone does no scrolling. The next zone out from
  89. the center gives a slow scroll. If the pointer above the center zone you will
  90. scroll down, if below you will scroll up. The top and bottom zones are for
  91. fast scrolling.
  92.  
  93.    Scrolling up or down by a window frame will be inaccurate if any lines
  94. within the displayed window frame contain more characters than can fit on
  95. a single  window line. When the cursor reaches the right edge of the window
  96. an automatic line feed is performed and the buffer line continues on the
  97. following window line. The problem is that this is still considered the
  98. same line to the program. Each time an automatic line feed is done the window
  99. frame scroll will go one line too far and the top line in the window frame
  100. will be scrolled off the display. If your buffer contains lines longer than
  101. the console window use the single line scroll instead of the window frame
  102. scroll.
  103.  
  104.    If another program sends something to the console window while in display
  105. mode it will be suspended until you return from display mode. While in display
  106. mode all keys will be ignored except for the arrow keys and the <q> key.
  107.  
  108.    To quit display mode and return to the normal console window enter a
  109. <q> from the keyboard. The windows original title will re-appear.
  110.  
  111. COMMAND LINE OPTIONS:
  112.  
  113.    The command lines listed below facilitate:
  114.       1. Setting the maximum number of lines to keep in memory.
  115.       2. Specifying a hardcopy device or file for a permanent record of
  116.          console IO.
  117.       3. Setting the update frequency for the hardcopy device or file.
  118.       4. Including time stamps on console prompts in the buffer data.
  119.       5. Reseting the buffer - releasing the current data from memory.
  120.       6. Sending the currently buffered data to a device or file.
  121.       7. Exiting the Console Buffer program.
  122.  
  123.    The first time CB is called a buffer is started and whatever command
  124. line options are specified are activated. After the buffer is started you
  125. may alter any of these options by calling CB again with whatever changes
  126. you desire on the command line. Only the options on the command line will
  127. be changed.
  128.  
  129.    For example: if you are using a hardcopy and wish to delete it enter
  130. <CB -h>, the lack of a name after the <h> switch will cause no hardcopy to
  131. be used. Any remaining lines in the buffer that have not been copied to the
  132. hardcopy will be flushed.
  133.  
  134.    SET MAX LINES:  <CB -l200>
  135.  
  136.       The -l option sets the maximum number of lines to keep in memory. If the
  137.    number of lines is set after the program has been running and is lower than
  138.    that being currently buffered by the program, excess lines in the buffer
  139.    will be discarded.
  140.  
  141.       The above example would set the maximum number of lines that the buffer
  142.    will hold at 200. At the 201st line the first line that went into the buffer
  143.    would be discarded and the 201st line entered at the end.
  144.  
  145.       If you are using the hardcopy option the maximum number of lines that the
  146.    buffer will hold must be set higher than the hardcopy update value. If you
  147.    try to set it lower an error message will appear and the -l option will not
  148.    be done.
  149.  
  150.    HARDCOPY:   <CB -hPRT: -u25>
  151.  
  152.       The -h option (hardcopy) allows you to make a permanent record of the
  153.    console I/O. The buffer data can be directed to any AmigaDOS device or file.
  154.  
  155.       The format of the command line is <CB -hname> where name if the name of
  156.    the file or device that you wish to receive the hardcopy data. Note that
  157.    there must be no intervening spaces between the <h> and the <name>.
  158.  
  159.       The above example would send the hardcopy data to the printer, writing
  160.    to the printer only after 25 lines have been accumulated, then sending
  161.    all 25 lines.
  162.  
  163.       Care should be used with this option as using the printer for hardcopy
  164.    will significantly slow down the console I/O, specifying a floppy disk file
  165.    will require that disk be installed all the time the buffer is running.
  166.    Having a hardcopy does not preclude the use of the buffer.
  167.  
  168.       The -u option (update) specifies the frequency of hardcopy access. For
  169.    safety the hardcopy is opened and closed each time data is sent to it.
  170.    Doing this can perceptibly slow down the console. Using the update command
  171.    line option you can set the update value for writing to the hardcopy device
  172.    or file. This value specifies the number of lines to accumulate in the
  173.    buffer before sending them to the hardcopy. The update value, which
  174.    defaults to 10 lines, must be less than the maximum number of lines to
  175.    buffer.
  176.  
  177.    TIME STAMP:
  178.  
  179.       The -t option will mark all prompt lines in the buffer with the time that
  180.    the command is entered. The time is in military format. This time stamp will
  181.    only be in the buffer, not on the CLI display.
  182.    
  183.    RESET BUFFER:
  184.  
  185.       The -r option (reset buffer) releases all the lines currently being held
  186.    in memory. Using the -r option does not change the maximum number of lines
  187.    that the buffer can hold. This option is only valid on a running Console
  188.    Buffer, it can not be specified at start-up.
  189.    
  190.    OUTPUT BUFFER:
  191.  
  192.       The -o option (output buffer) dumps all of the lines currently being held
  193.    in memory to the specified file or device. The format is <CB -oname> where
  194.    name if the file or device you wish to receive the data. Note that there
  195.    must be no intervening spaces between the <o> and the <name>.
  196.       This option only pertains to a running Console Buffer and cannot be
  197.    specified on program start-up.
  198.  
  199.    QUIT:
  200.  
  201.       To quit and recover memory used by the buffer, type <CB -q>. If this
  202.    hangs do to an error in the conbuf-handler module you can exit with a
  203.    Control-C. Ending the CLI that the buffer is attached to will automatically
  204.    end that Console Buffer, recovering all memory used.
  205.  
  206. MEMORY REQUIREMENTS:
  207.  
  208.    After the program is started the storage used is approximately 9 K, plus
  209. the lines buffered. Each line buffered uses the size of the line plus eight
  210. bytes. Running the program with a 100 line buffer will use about 14K of
  211. storage. Using a 500 line buffer will require about 28K.
  212.  
  213. COMMENTS:
  214.  
  215.    Any comments, constructive criticism or useful additions to the program
  216. may be directed to me at the above address or on GEnie mail address W.FRITZ1
  217.